Benefits Eligibility Verification System API - Implementation Template
Setup guide
Please review the pre-requisite setup instructions to create an Account and App subscription in Availity.
Importing Templates into Anypoint Studio
- In Studio, click the Exchange X icon in the upper left of the taskbar.
- Log in with your Anypoint Platform credentials.
- Search for the template.
- Click Open.
Running Templates in Anypoint Studio
After you import your template into Studio, follow these configuration steps to run it:
Common Configuration
mule.env
- sets the environment where the application is to be deployed. It should be configured inconfig-<mule.env>.yaml
file. For a studio deployment, the recommended mule.env value islocal
.mule.key
- sets the encryption password to be used for encrypting secure properties. Update as needed.api.baseurl
- sets the base url of the api. Replace/override as needed when deploying to any environment. It should be configured inconfig-<mule.env>.yaml
file. Default value ishttp://localhost:8081/api
, whenmule.env
islocal
.api.autodiscoveryID
should be configured inconfig-<mule.env>.yaml
file.
Availity Configuration
availity.tokenurl
- sets the token url for Availity. It should be configured inconfig-<mule.env>.yaml
file.availity.baseurl
- sets the base url for Availity requests. It should be configured inconfig-<mule.env>.yaml
file.availity.scopes
- set the scopes for the OAuth request to Availity Token Url. Update the scopes as required for the operations. It should be configured inconfig-<mule.env>.yaml
file.availity.clientid
- sets the client id to be used for requests to Availity Url. It should be configured inconfig-<mule.env>.yaml
file.availity.clientsecret
- sets the client secret to be used for requests to Availity Url. It should be encrypted and configured inconfig-secured-<mule.env>.yaml
file.
HTTPS Configuration
https.host
— sets the service host interface. It should be configured inconfig-<mule.env>.yaml
file (Defaults to 0.0.0.0 for all interfaces).https.port
— sets the HTTPS service port number. It should be configured inconfig-<mule.env>.yaml
file (Default 8082).- TLS Configuration - Keystore properties setup:
keystore.alias
- sets the alias to the keystore. It should be configured inconfig-<mule.env>.yaml
file.keystore.path
- sets the path to the key file. Key should be available in /src/main/resources/keystore. It should be configured inconfig-<mule.env>.yaml
file.keystore.keypass
— sets keystore keypass to support HTTPS operation. It should be encrypted and configured inconfig-secured-<mule.env>.yaml
file.keystore.password
— sets keystore password to support HTTPS operation. It should be encrypted and configured inconfig-secured-<mule.env>.yaml
file.
Please refer to the attached link on how to generate the Keystore.
Run it
- Right-click the template project folder.
- Hover your mouse over Run as.
- Click Mule Application (configure).
- Inside the dialog, select Environment and set the variable mule.env to the appropriate value (e.g dev or local).
- Inside the dialog, select Environment and set the variable mule.key to the property encryption key that you used to encrypt your secure properties. Click Run.
Deployment instructions for CloudHub using provided scripts
Ensure the Maven profile CloudHub-DEV
has been properly configured in yoursettings.xml
file. Reference can be found by downloading the Accelerator Setup Guide asset. Additional instructions are available in Accelerator Setup Guide - Configuring the Accelerator Build
section.
Update the config-dev.yaml
properties appropriately and then use one of the following
scripts to deploy application to CloudHub:
- packageDeploy.sh or deployOnly.sh (Mac/Linux)
- packageDeploy.cmd or deployOnly.cmd (Windows)
Test it
- Use Advanced Rest Client or Postman to send request over HTTPS. The template includes a postman collection in
src/test/resources
folder. Update the collection variable(s) after successful import.